<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Core Plot (Mac OS): &lt;CPTLegendDelegate&gt; Protocol Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="customdoxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  <td id="projectlogo"><img alt="Logo" src="core-plot-logo.png"/></td>
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Core Plot (Mac OS)
   
   </div>
   <div id="projectbrief">Cocoa plotting framework for Mac OS X and iOS</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript" src="dynsections.js"></script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Animation&#160;&&#160;Constants</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('protocol_c_p_t_legend_delegate-p.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">&lt;CPTLegendDelegate&gt; Protocol Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="CPTLegendDelegate-p" --><!-- doxytag: inherits="NSObject-p-p" -->
<p>Axis labeling delegate.  
 <a href="protocol_c_p_t_legend_delegate-p.html#details">More...</a></p>

<p><code>#import &lt;<a class="el" href="_c_p_t_legend_8h_source.html">CPTLegend.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for &lt;CPTLegendDelegate&gt;:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="protocol_c_p_t_legend_delegate-p__inherit__graph.png" border="0" usemap="#_3_c_p_t_legend_delegate_4_inherit__map" alt="Inheritance graph"/></div>
<map name="_3_c_p_t_legend_delegate_4_inherit__map" id="_3_c_p_t_legend_delegate_4_inherit__map">
<area shape="rect" id="node2" href="http://developer.apple.com/documentation/Cocoa/Reference/Foundation/Protocols/NSObject_Protocol/Reference/NSObject.html" title="\&lt;NSObject&#45;p\&gt;" alt="" coords="32,6,149,37"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for &lt;CPTLegendDelegate&gt;:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="protocol_c_p_t_legend_delegate-p__coll__graph.png" border="0" usemap="#_3_c_p_t_legend_delegate_4_coll__map" alt="Collaboration graph"/></div>
<map name="_3_c_p_t_legend_delegate_4_coll__map" id="_3_c_p_t_legend_delegate_4_coll__map">
<area shape="rect" id="node2" href="http://developer.apple.com/documentation/Cocoa/Reference/Foundation/Protocols/NSObject_Protocol/Reference/NSObject.html" title="\&lt;NSObject&#45;p\&gt;" alt="" coords="32,6,149,37"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="protocol_c_p_t_legend_delegate-p-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Instance Methods</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Drawing</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(<a class="elRef" href="http://developer.apple.com/mac/library/documentation/Cocoa/Reference/ObjCRuntimeRef/Reference/reference.html">BOOL</a>)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_c_p_t_legend_delegate-p.html#a296de27e682d78b5caabd715912eb164">legend:shouldDrawSwatchAtIndex:forPlot:inRect:inContext:</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">(Required) This method gives the delegate a chance to draw custom swatches for each legend entry.  <a href="#a296de27e682d78b5caabd715912eb164"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Axis labeling delegate. </p>
</div><hr/><h2>Method Documentation</h2>
<a class="anchor" id="a296de27e682d78b5caabd715912eb164"></a><!-- doxytag: member="CPTLegendDelegate&#45;p::legend:shouldDrawSwatchAtIndex:forPlot:inRect:inContext:" ref="a296de27e682d78b5caabd715912eb164" args="(CPTLegend *legend,[shouldDrawSwatchAtIndex] NSUInteger index,[forPlot] CPTPlot *plot,[inRect] CGRect rect,[inContext] CGContextRef context)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (<a class="elRef" href="http://developer.apple.com/mac/library/documentation/Cocoa/Reference/ObjCRuntimeRef/Reference/reference.html">BOOL</a>) legend: </td>
          <td></td>
          <td class="paramtype">(<a class="el" href="interface_c_p_t_legend.html">CPTLegend</a> *)&#160;</td>
          <td class="paramname"><em>legend</em></td>
        </tr>
        <tr>
          <td class="paramkey">shouldDrawSwatchAtIndex:</td>
          <td></td>
          <td class="paramtype">(<a class="elRef" href="http://developer.apple.com/mac/library/documentation/Cocoa/Reference/Foundation/Miscellaneous/Foundation_DataTypes/Reference/reference.html">NSUInteger</a>)&#160;</td>
          <td class="paramname"><em>index</em></td>
        </tr>
        <tr>
          <td class="paramkey">forPlot:</td>
          <td></td>
          <td class="paramtype">(<a class="el" href="interface_c_p_t_plot.html">CPTPlot</a> *)&#160;</td>
          <td class="paramname"><em>plot</em></td>
        </tr>
        <tr>
          <td class="paramkey">inRect:</td>
          <td></td>
          <td class="paramtype">(<a class="elRef" href="http://developer.apple.com/documentation/GraphicsImaging/Reference/CGGeometry/Reference/reference.html#//apple_ref/doc/c_ref/CGRect.html">CGRect</a>)&#160;</td>
          <td class="paramname"><em>rect</em></td>
        </tr>
        <tr>
          <td class="paramkey">inContext:</td>
          <td></td>
          <td class="paramtype">(<a class="elRef" href="http://developer.apple.com/documentation/GraphicsImaging/Reference/CGContext/Reference/reference.html#//apple_ref/doc/c_ref/CGContextRef.html">CGContextRef</a>)&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>(Required) This method gives the delegate a chance to draw custom swatches for each legend entry. </p>
<p>The "swatch" is the graphical part of the legend entry, usually accompanied by a text title that will be drawn by the legend. Returning NO will cause the legend to not draw the default legend graphics. It is then the delegate's responsiblity to do this. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">legend</td><td>The legend. </td></tr>
    <tr><td class="paramname">index</td><td>The zero-based index of the legend entry for the given plot. </td></tr>
    <tr><td class="paramname">plot</td><td>The plot. </td></tr>
    <tr><td class="paramname">rect</td><td>The bounding rectangle to use when drawing the swatch. </td></tr>
    <tr><td class="paramname">context</td><td>The graphics context to draw into. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>YES if the legend should draw the default swatch or NO if the delegate handled the drawing. </dd></dl>

</div>
</div>
<hr/>The documentation for this protocol was generated from the following file:<ul>
<li>Source/<a class="el" href="_c_p_t_legend_8h_source.html">CPTLegend.h</a></li>
</ul>
</div><!-- contents -->
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="protocol_c_p_t_legend_delegate-p.html">CPTLegendDelegate</a>      </li>

    <li class="footer">Generated by <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a></li>
   </ul>
 </div>


</body>
</html>
